<?xml version='1.0' encoding='iso-8859-1'?>
<!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
	<head>
		<title>
			plcID.c
			</title>
		<meta http-equiv='content-type' content='text/html;iso-8859-1'/>
		<meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
		<meta name='author' content='cmaier@cmassoc.net'/>
		<meta name='robots' content='noindex,nofollow'/>
		<link href='toolkit.css' rel='stylesheet' type='text/css'/>
		</head>
	<body>
		<div class='headerlink'>
			[<a href='plchostd.c.html' title=' plchostd.c '>PREV</a>]
			[<a href='toolkit.html' title=' Index '>HOME</a>]
			[<a href='plclist.c.html' title=' plclist.c '>NEXT</a>]
			</div>
<pre>
/*====================================================================*
 *
 *   Copyright (c) 2013 Qualcomm Atheros, Inc.
 *
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or 
 *   without modification, are permitted (subject to the limitations 
 *   in the disclaimer below) provided that the following conditions 
 *   are met:
 *
 *   * Redistributions of source code must retain the above copyright 
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above 
 *     copyright notice, this list of conditions and the following 
 *     disclaimer in the documentation and/or other materials 
 *     provided with the distribution.
 *
 *   * Neither the name of Qualcomm Atheros nor the names of 
 *     its contributors may be used to endorse or promote products 
 *     derived from this software without specific prior written 
 *     permission.
 *
 *   NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE 
 *   GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE 
 *   COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR 
 *   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 *   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 
 *   OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 *   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 *   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 *   OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 *   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  
 *
 *--------------------------------------------------------------------*/

/*====================================================================*
 *
 *   plcID.c - Qualcomm Atheros Powerline Device Identity
 *
 *
 *   Contributor(s):
 *      Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
 *
 *--------------------------------------------------------------------*/

/*====================================================================*&quot;
 *   system header files;
 *--------------------------------------------------------------------*/

#include &lt;unistd.h&gt;
#include &lt;stdlib.h&gt;
#include &lt;limits.h&gt;
#include &lt;string.h&gt;
#include &lt;ctype.h&gt;

/*====================================================================*
 *   custom header files;
 *--------------------------------------------------------------------*/

#include &quot;../tools/getoptv.h&quot;
#include &quot;../tools/putoptv.h&quot;
#include &quot;../tools/memory.h&quot;
#include &quot;../tools/number.h&quot;
#include &quot;../tools/symbol.h&quot;
#include &quot;../tools/types.h&quot;
#include &quot;../tools/flags.h&quot;
#include &quot;../tools/files.h&quot;
#include &quot;../tools/error.h&quot;
#include &quot;../plc/plc.h&quot;
#include &quot;../ram/nvram.h&quot;
#include &quot;../ram/sdram.h&quot;
#include &quot;../nvm/nvm.h&quot;
#include &quot;../pib/pib.h&quot;
#include &quot;../mme/mme.h&quot;

/*====================================================================*
 *   custom source files;
 *--------------------------------------------------------------------*/

#ifndef MAKEFILE
#include &quot;../tools/getoptv.c&quot;
#include &quot;../tools/putoptv.c&quot;
#include &quot;../tools/version.c&quot;
#include &quot;../tools/uintspec.c&quot;
#include &quot;../tools/hexencode.c&quot;
#include &quot;../tools/hexdecode.c&quot;
#include &quot;../tools/todigit.c&quot;
#include &quot;../tools/hexdump.c&quot;
#include &quot;../tools/hexout.c&quot;
#include &quot;../tools/error.c&quot;
#include &quot;../tools/synonym.c&quot;
#include &quot;../tools/checksum32.c&quot;
#include &quot;../tools/typename.c&quot;
#endif

#ifndef MAKEFILE
#include &quot;../plc/Display.c&quot;
#include &quot;../plc/Devices.c&quot;
#include &quot;../plc/Failure.c&quot;
#include &quot;../plc/ReadMME.c&quot;
#include &quot;../plc/SendMME.c&quot;
#include &quot;../plc/WaitForStart.c&quot;
#include &quot;../plc/chipset.c&quot;
#endif

#ifndef MAKEFILE
#include &quot;../mme/EthernetHeader.c&quot;
#include &quot;../mme/QualcommHeader.c&quot;
#include &quot;../mme/UnwantedMessage.c&quot;
#endif

#ifndef MAKEFILE
#include &quot;../ether/openchannel.c&quot;
#include &quot;../ether/closechannel.c&quot;
#include &quot;../ether/readpacket.c&quot;
#include &quot;../ether/sendpacket.c&quot;
#include &quot;../ether/channel.c&quot;
#endif

#ifndef MAKEFILE
#include &quot;../mme/MMECode.c&quot;
#endif

/*====================================================================*
 *   program constants;
 *--------------------------------------------------------------------*/

#define PLCID_DAK 0
#define PLCID_NMK 1
#define PLCID_MAC 2
#define PLCID_MFG 3
#define PLCID_USR 4
#define PLCID_NET 5

/*====================================================================*
 *
 *   signed PLCSelect (struct plc * plc, signed old (struct plc *), signed new (struct plc *));
 *
 *   plc.h
 *
 *   wait for device to start in order to determine chipset then call
 *   the approproate function based on chipset; unfortunately, chipset
 *   detection and selection may not be this simple in the future;
 *
 *   Contributor(s):
 *      Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
 *
 *--------------------------------------------------------------------*/

signed PLCSelect (struct plc * plc, signed old (struct plc *), signed new (struct plc *))

{
	char firmware [PLC_VERSION_STRING];
	if (WaitForStart (plc, firmware, sizeof (firmware)))
	{
		Failure (plc, PLC_NODETECT);
		exit (1);
	}
	return ((plc-&gt;hardwareID &lt; CHIPSET_QCA7420)? old (plc): new (plc));
}

/*====================================================================*
 *
 *   signed ReadKey1 (struct plc * plc);
 *
 *   read the first block of the PIB from a device then echo one of
 *   several parameters on stdout as a string; program output can be
 *   used in scripts to define variables or compare strings;
 *
 *   this function is an abridged version of ReadParameters(); it reads only
 *   the first 1024 bytes of the PIB then stops; most parameters of
 *   general interest occur in that block;
 *
 *--------------------------------------------------------------------*/

static signed ReadKey1 (struct plc * plc)

{
	static signed count = 0;
	struct channel * channel = (struct channel *) (plc-&gt;channel);
	struct message * message = (struct message *) (plc-&gt;message);

#ifndef __GNUC__
#pragma pack (push,1)
#endif

	struct __packed vs_rd_mod_request
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint8_t MODULEID;
		uint8_t RESERVED;
		uint16_t MLENGTH;
		uint32_t MOFFSET;
		uint8_t DAK [16];
	}
	* request = (struct vs_rd_mod_request *) (message);
	struct __packed vs_rd_mod_confirm
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint8_t MSTATUS;
		uint8_t RESERVED1 [3];
		uint8_t MODULEID;
		uint8_t RESERVED2;
		uint16_t MLENGTH;
		uint32_t MOFFSET;
		uint32_t MCHKSUM;
		struct simple_pib pib;
	}
	* confirm = (struct vs_rd_mod_confirm *) (message);

#ifndef __GNUC__
#pragma pack (pop)
#endif

	memset (message, 0, sizeof (* message));
	EthernetHeader (&amp; request-&gt;ethernet, channel-&gt;peer, channel-&gt;host, channel-&gt;type);
	QualcommHeader (&amp; request-&gt;qualcomm, 0, (VS_RD_MOD | MMTYPE_REQ));
	request-&gt;MODULEID = VS_MODULE_PIB;
	request-&gt;MLENGTH = HTOLE16 (PLC_RECORD_SIZE);
	request-&gt;MOFFSET = HTOLE32 (0);
	plc-&gt;packetsize = ETHER_MIN_LEN - ETHER_CRC_LEN;
	if (SendMME (plc) &lt;= 0)
	{
		error (1, errno, CHANNEL_CANTSEND);
	}
	while (ReadMME (plc, 0, (VS_RD_MOD | MMTYPE_CNF)) &gt; 0)
	{
		if (confirm-&gt;MSTATUS)
		{
			Failure (plc, PLC_WONTDOIT);
			return (-1);
		}
		if (count++ &gt; 0)
		{
			putc (plc-&gt;coupling, stdout);
		}
		if (plc-&gt;action == PLCID_MAC)
		{
			hexout (confirm-&gt;pib.MAC, sizeof (confirm-&gt;pib.MAC), HEX_EXTENDER, 0, stdout);
		}
		else if (plc-&gt;action == PLCID_DAK)
		{
			hexout (confirm-&gt;pib.DAK, sizeof (confirm-&gt;pib.DAK), HEX_EXTENDER, 0, stdout);
		}
		else if (plc-&gt;action == PLCID_NMK)
		{
			hexout (confirm-&gt;pib.NMK, sizeof (confirm-&gt;pib.NMK), HEX_EXTENDER, 0, stdout);
		}
		else if (plc-&gt;action == PLCID_MFG)
		{
			confirm-&gt;pib.MFG [PIB_HFID_LEN -1] = (char) (0);
			printf (&quot;%s&quot;, confirm-&gt;pib.MFG);
		}
		else if (plc-&gt;action == PLCID_USR)
		{
			confirm-&gt;pib.USR [PIB_HFID_LEN -1] = (char) (0);
			printf (&quot;%s&quot;, confirm-&gt;pib.USR);
		}
		else if (plc-&gt;action == PLCID_NET)
		{
			confirm-&gt;pib.NET [PIB_HFID_LEN -1] = (char) (0);
			printf (&quot;%s&quot;, confirm-&gt;pib.NET);
		}
	}
	if (plc-&gt;packetsize &lt; 0)
	{
		error (1, errno, CHANNEL_CANTREAD);
	}
	return (0);
}

/*====================================================================*
 *
 *   signed ReadKey2 (struct plc * plc);
 *
 *   plc.h
 *
 *   read start of parameter chain from the device using a single
 *   VS_MODULE_OPERATION message; search parameter chain for PIB and
 *   print requested plc-&gt;action on stdout;
 *
 *   Contributor(s):
 *      Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
 *
 *--------------------------------------------------------------------*/

static signed ReadKey2 (struct plc * plc)

{
	static signed count = 0;
	struct channel * channel = (struct channel *) (plc-&gt;channel);
	struct message * message = (struct message *) (plc-&gt;message);
	struct nvm_header2 * nvm_header;
	uint32_t origin = ~ 0;
	uint32_t offset = 0;
	signed module = 0;
	char * filename = &quot;device&quot;;

#ifndef __GNUC__
#pragma pack (push,1)
#endif

	struct __packed vs_module_operation_read_request
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint32_t RESERVED;
		uint8_t NUM_OP_DATA;
		struct __packed
		{
			uint16_t MOD_OP;
			uint16_t MOD_OP_DATA_LEN;
			uint32_t MOD_OP_RSVD;
			uint16_t MODULE_ID;
			uint16_t MODULE_SUB_ID;
			uint16_t MODULE_LENGTH;
			uint32_t MODULE_OFFSET;
		}
		MODULE_SPEC;
	}
	* request = (struct vs_module_operation_read_request *) (message);
	struct __packed vs_module_operation_read_confirm
	{
		struct ethernet_hdr ethernet;
		struct qualcomm_hdr qualcomm;
		uint16_t MSTATUS;
		uint16_t ERR_REC_CODE;
		uint32_t RESERVED;
		uint8_t NUM_OP_DATA;
		struct __packed
		{
			uint16_t MOD_OP;
			uint16_t MOD_OP_DATA_LEN;
			uint32_t MOD_OP_RSVD;
			uint16_t MODULE_ID;
			uint16_t MODULE_SUB_ID;
			uint16_t MODULE_LENGTH;
			uint32_t MODULE_OFFSET;
		}
		MODULE_SPEC;
		uint8_t MODULE_DATA [PLC_MODULE_SIZE];
	}
	* confirm = (struct vs_module_operation_read_confirm *) (message);

#ifndef __GNUC__
#pragma pack (pop)
#endif

	memset (message, 0, sizeof (* message));
	EthernetHeader (&amp; request-&gt;ethernet, channel-&gt;peer, channel-&gt;host, channel-&gt;type);
	QualcommHeader (&amp; request-&gt;qualcomm, 0, (VS_MODULE_OPERATION | MMTYPE_REQ));
	plc-&gt;packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
	request-&gt;NUM_OP_DATA = 1;
	request-&gt;MODULE_SPEC.MOD_OP = HTOLE16 (0);
	request-&gt;MODULE_SPEC.MOD_OP_DATA_LEN = HTOLE16 (sizeof (request-&gt;MODULE_SPEC));
	request-&gt;MODULE_SPEC.MOD_OP_RSVD = HTOLE32 (0);
	request-&gt;MODULE_SPEC.MODULE_ID = HTOLE16 (PLC_MODULEID_PARAMETERS);
	request-&gt;MODULE_SPEC.MODULE_SUB_ID = HTOLE16 (0);
	request-&gt;MODULE_SPEC.MODULE_LENGTH = HTOLE16 (PLC_MODULE_SIZE);
	request-&gt;MODULE_SPEC.MODULE_OFFSET = HTOLE32 (0);
	if (SendMME (plc) &lt;= 0)
	{
		error (1, errno, CHANNEL_CANTSEND);
	}
	while (ReadMME (plc, 0, (VS_MODULE_OPERATION | MMTYPE_CNF)) &gt; 0)
	{
		if (confirm-&gt;MSTATUS)
		{
			Failure (plc, PLC_WONTDOIT);
			return (-1);
		}
		if (count++ &gt; 0)
		{
			putc (plc-&gt;coupling, stdout);
		}
		do 
		{
			nvm_header = (struct nvm_header2 *) (&amp; confirm-&gt;MODULE_DATA [offset]);
			if (LE16TOH (nvm_header-&gt;MajorVersion) != 1)
			{
				if (_allclr (plc-&gt;flags, PLC_SILENCE))
				{
					error (0, errno, NVM_HDR_VERSION, filename, module);
				}
				return (-1);
			}
			if (LE16TOH (nvm_header-&gt;MinorVersion) != 1)
			{
				if (_allclr (plc-&gt;flags, PLC_SILENCE))
				{
					error (0, errno, NVM_HDR_VERSION, filename, module);
				}
				return (-1);
			}
			if (LE32TOH (nvm_header-&gt;PrevHeader) != origin)
			{
				if (_allclr (plc-&gt;flags, PLC_SILENCE))
				{
					error (0, errno, NVM_HDR_LINK, filename, module);
				}
				return (-1);
			}
			if (checksum32 (nvm_header, sizeof (* nvm_header), 0))
			{
				error (0, 0, NVM_HDR_CHECKSUM, filename, module);
				return (-1);
			}
			origin = offset;
			offset += sizeof (* nvm_header);
			if (LE32TOH (nvm_header-&gt;ImageType) == NVM_IMAGE_PIB)
			{
				struct simple_pib * pib = (struct simple_pib *) (&amp; confirm-&gt;MODULE_DATA [offset]);
				if (plc-&gt;action == PLCID_MAC)
				{
					hexout (pib-&gt;MAC, sizeof (pib-&gt;MAC), HEX_EXTENDER, 0, stdout);
				}
				else if (plc-&gt;action == PLCID_DAK)
				{
					hexout (pib-&gt;DAK, sizeof (pib-&gt;DAK), HEX_EXTENDER, 0, stdout);
				}
				else if (plc-&gt;action == PLCID_NMK)
				{
					hexout (pib-&gt;NMK, sizeof (pib-&gt;NMK), HEX_EXTENDER, 0, stdout);
				}
				else if (plc-&gt;action == PLCID_MFG)
				{
					pib-&gt;MFG [PIB_HFID_LEN -1] = (char) (0);
					printf (&quot;%s&quot;, pib-&gt;MFG);
				}
				else if (plc-&gt;action == PLCID_USR)
				{
					pib-&gt;USR [PIB_HFID_LEN -1] = (char) (0);
					printf (&quot;%s&quot;, pib-&gt;USR);
				}
				else if (plc-&gt;action == PLCID_NET)
				{
					pib-&gt;NET [PIB_HFID_LEN -1] = (char) (0);
					printf (&quot;%s&quot;, pib-&gt;NET);
				}
				break;
			}
			if (checksum32 (&amp; confirm-&gt;MODULE_DATA [offset], LE32TOH (nvm_header-&gt;ImageLength), nvm_header-&gt;ImageChecksum))
			{
				if (_allclr (plc-&gt;flags, PLC_SILENCE))
				{
					error (0, errno, NVM_IMG_CHECKSUM, filename, module);
				}
				return (-1);
			}
			offset += LE32TOH (nvm_header-&gt;ImageLength);
			module++;
		}
		while (~ nvm_header-&gt;NextHeader);
	}
	if (plc-&gt;packetsize &lt; 0)
	{
		error (1, errno, CHANNEL_CANTREAD);
	}
	return (0);
}

/*====================================================================*
 *
 *   int main (int argc, char const * argv []);
 *
 *--------------------------------------------------------------------*/

int main (int argc, char const * argv [])

{
	extern struct channel channel;
	static char const * optv [] =
	{
		&quot;Ac:Dei:MnNqSUv&quot;,
		&quot;device&quot;,
		&quot;Qualcomm Atheros Powerline Device Identity&quot;,
		&quot;A\tEthernet address (MAC)&quot;,
		&quot;c c\tcharacter delimiter is (c)&quot;,
		&quot;D\tDevice Access Key (DAK)&quot;,
		&quot;e\tredirect stderr to stdout&quot;,

#if defined (WINPCAP) || defined (LIBPCAP)

		&quot;i n\thost interface is (n) [&quot; LITERAL (CHANNEL_ETHNUMBER) &quot;]&quot;,

#else

		&quot;i s\thost interface is (s) [&quot; LITERAL (CHANNEL_ETHDEVICE) &quot;]&quot;,

#endif

		&quot;M\tNetwork Membership Key (NMK)&quot;,
		&quot;n\tappend newline on output&quot;,
		&quot;N\tnetwork HFID&quot;,
		&quot;q\tquiet mode&quot;,
		&quot;S\tmanufacturer HFID&quot;,
		&quot;U\tuser HFID&quot;,
		&quot;v\tverbose mode&quot;,
		(char const *) (0)
	};

#include &quot;../plc/plc.c&quot;

	signed c;
	plc.action = PLCID_DAK;
	plc.coupling = '\n';
	if (getenv (PLCDEVICE))
	{

#if defined (WINPCAP) || defined (LIBPCAP)

		channel.ifindex = atoi (getenv (PLCDEVICE));

#else

		channel.ifname = strdup (getenv (PLCDEVICE));

#endif

	}
	optind = 1;
	while (~ (c = getoptv (argc, argv, optv)))
	{
		switch (c)
		{
		case 'A':
			plc.action = PLCID_MAC;
			break;
		case 'c':
			plc.coupling = * optarg;
			break;
		case 'D':
			plc.action = PLCID_DAK;
			break;
		case 'e':
			dup2 (STDOUT_FILENO, STDERR_FILENO);
			break;
		case 'i':

#if defined (WINPCAP) || defined (LIBPCAP)

			channel.ifindex = atoi (optarg);

#else

			channel.ifname = optarg;

#endif

			break;
		case 'M':
			plc.action = PLCID_NMK;
			break;
		case 'n':
			_setbits (plc.flags, PLC_NEWLINE);
			break;
		case 'N':
			plc.action = PLCID_NET;
			break;
		case 'q':
			_setbits (channel.flags, CHANNEL_SILENCE);
			_setbits (plc.flags, PLC_SILENCE);
			break;
		case 'S':
			plc.action = PLCID_MFG;
			break;
		case 'U':
			plc.action = PLCID_USR;
			break;
		case 'v':
			_setbits (channel.flags, CHANNEL_VERBOSE);
			_setbits (plc.flags, PLC_VERBOSE);
			break;
		default: 
			break;
		}
	}
	argc -= optind;
	argv += optind;
	openchannel (&amp; channel);
	if (! (plc.message = malloc (sizeof (* plc.message))))
	{
		error (1, errno, PLC_NOMEMORY);
	}
	if (! argc)
	{
		PLCSelect (&amp; plc, ReadKey1, ReadKey2);
	}
	while ((argc) &amp;&amp; (* argv))
	{
		if (! hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
		{
			error (1, errno, PLC_BAD_MAC, * argv);
		}
		PLCSelect (&amp; plc, ReadKey1, ReadKey2);
		argv++;
		argc--;
	}
	if (_anyset (plc.flags, PLC_NEWLINE))
	{
		printf (&quot;\n&quot;);
	}
	free (plc.message);
	closechannel (&amp; channel);
	return (0);
}


</pre>
		<div class='footerlink'>
			[<a href='plchostd.c.html' title=' plchostd.c '>PREV</a>]
			[<a href='toolkit.html' title=' Index '>HOME</a>]
			[<a href='plclist.c.html' title=' plclist.c '>NEXT</a>]
			</div>
		</body>
	</html>
